Skip to content

docs: document and demo use_shortcuts keyboard shortcuts#1891

Merged
Lee-W merged 7 commits intocommitizen-tools:masterfrom
ttw225:docs/cz-configure-shortcuts
Mar 14, 2026
Merged

docs: document and demo use_shortcuts keyboard shortcuts#1891
Lee-W merged 7 commits intocommitizen-tools:masterfrom
ttw225:docs/cz-configure-shortcuts

Conversation

@ttw225
Copy link
Contributor

@ttw225 ttw225 commented Mar 9, 2026

Description

This PR improves the documentation and demos for the use_shortcuts configuration option.

  • Material theme (mkdocs.yml)
  • docs
    • grouping code blocks
      • config/configuration_file
      • customization/config_file
    • add description examples (config and GIFs)
      • config/configuration_file/#customization
      • customization/config_file/#shortcut-keys

Checklist

Was generative AI tooling used to co-author this PR?

  • Yes (please specify the tool below)

Generated-by: [Cursor] following the guidelines

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external)

Expected Behavior

Steps to Test This Pull Request

Run uv run poe doc

Additional Context

Copy link
Collaborator

@bearomorphism bearomorphism left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution!

@Lee-W Lee-W merged commit 211bcb3 into commitizen-tools:master Mar 14, 2026
18 checks passed
@ttw225 ttw225 deleted the docs/cz-configure-shortcuts branch March 14, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants